home *** CD-ROM | disk | FTP | other *** search
/ MacTech 1 to 12 / MacTech-vol-1-12.toast / Tools / Bare Bones PopupFuncs 2.8.2 / PopupFuncs Notes.c < prev    next >
Text File  |  1997-03-13  |  12KB  |  348 lines
  1. /*
  2. PopupFuncs 2.8 Notes
  3. ---------- --- -----
  4.  
  5. March 13, 1997
  6.  
  7. Because PopupFuncs is so simple to use, this text file constitutes the
  8. documentation for installing and using PopupFuncs. It also contains
  9. up-to-date news and information.
  10.  
  11. The license agreement for PopupFuncs is at the end of this file. Please
  12. read it before installing and using the software.
  13. */
  14.  
  15. #pragma mark What is PopupFuncs?
  16.  
  17. /*
  18. What is PopupFuncs?
  19. ---- -- -----------
  20.  
  21. PopUpFuncs (“PUF”) is a productivity tool for developers. When invoked
  22. by clicking on a control in a source code window’s title bar, it
  23. creates a popup menu of every function contained in a source code file,
  24. allowing you to see instantly the contents of an unfamiliar file. If a
  25. name is selected from the menu, the file is instantly scrolled to the
  26. beginning of that function. PopUpFuncs works with CodeWarrior, MPW,
  27. THINK C/Symantec C++, SADE, BBEdit, and QUED/M, and parses C, C++,
  28. Pascal, Object Pascal, assembler, Rez, Fortran, and Java source files.
  29.  
  30. PopUpFuncs is extensible through an XCMD-like protocol. This package
  31. includes a language sensitive block-commenting and uncommenting tool
  32. which operates on the current selection. Hold the command key down
  33. while clicking on a control to get the XPOP menu. This package also
  34. includes the source code to this XPOP, as well as everything you need
  35. to build your own XPOPs.
  36.  
  37. PopUpFuncs is very fast, highly addictive, and VERY useful.
  38.  
  39. To install PopUpFuncs, launch the Installer and install PopupFuncs in
  40. your copy of BBEdit, CodeWarrior, MPW, THINK C, THINK Project Manager,
  41. Symantec Project Manager, or QUED/M. Do this now, and you’ll be able to
  42. try out PopUpFuncs on this very file!
  43. */
  44.  
  45. #pragma mark Installation
  46.  
  47. /*
  48. Installation
  49. ------------
  50.  
  51. To install PopupFuncs, launch the “PopupFuncs Installer” application.
  52. For each editor you wish to use PopupFuncs in, click the “Install” button
  53. and select the editor. (The editor must not be running at the time.)
  54.  
  55. After you have installed PopupFuncs in your editor(s), click the “Quit”
  56. button.
  57. */
  58.  
  59. #pragma mark Standard File Hacks
  60.  
  61. /*
  62. Standard File Hacks
  63. -------- ---- -----
  64.  
  65. There are some third-party extensions which modify the standard “Open” and
  66. “Save” dialogs (known colloquially as “Standard File”). In a couple of
  67. known cases, some of these extensions have a bug which causes correctly
  68. written applications to crash. Specifically:
  69.  
  70. -    “Click, there it is!”, version 1.0.1. Version 1.0.4 or later fixes
  71.     this problem. Registered owners should contact the author for more
  72.     information.
  73.     
  74. -    Quickeys version 2.1 also appears to have a similar problem.
  75.  
  76. If either of these extensions is installed, the PopupFuncs installer will
  77. crash when you click the “Choose...” button. As a workaround, if you have
  78. System 7.5 installed, you can simply drag a supported application to the
  79. status area in the PopupFuncs installer's window.
  80. */
  81.  
  82. #pragma mark Supported Editors
  83.  
  84. /*
  85. Supported Editors
  86. --------- -------
  87.  
  88. The following text editors (including integrated development environments)
  89. work with PopupFuncs. If you are writing an editor and would like to work
  90. with PopupFuncs, please write to us for information on the PopupFuncs API.
  91.  
  92. PopupFuncs works with the following editors:
  93.  
  94.     BBEdit 2.5 and later (Bare Bones Software) (see note below)
  95.     BBEdit Lite 2.3 and later (Bare Bones Software)
  96.     THINK C 5.0 and later (Symantec)
  97.     Symantec C++ 6.0 and later (Symantec)
  98.     CodeWarrior 1.0.1 and later (Metrowerks)
  99.     MPW Shell 3.0 and later (Apple Computer)
  100.     QUED/M 2.7 and later (Nisus Software)
  101.  
  102. If you are using the “native” MPW Shell, be advised that versions of the
  103. native Shell prior to 3.4b6 are incompatible with PopupFuncs. The first
  104. compatible version of the native MPW Shell is 3.4b6, which was released
  105. as part of the ETO 18 distribution.
  106.  
  107. Please note that BBEdit 3.0 and later feature integrated PopupFuncs
  108. technology, so installing PopupFuncs in recent versions of BBEdit is
  109. probably redundant. However, if you've become accustomed to using
  110. PopupFuncs in other environments, feel free to install it into BBEdit.
  111. */
  112.  
  113. #pragma mark Changes from Previous Versions
  114.  
  115. /*
  116. Changes from Previous Versions
  117. ------- ---- -------- --------
  118.  
  119. Version 2.8.2:
  120.  
  121.     -    improved template support in C++ scanner.
  122.     
  123.     -    Pascal scanner now displays method names in the popup menu.
  124.     
  125.     -    updated company contact information.
  126.     
  127. Version 2.8.1:
  128.  
  129.     -    incorporates various and sundry scanner fixes.
  130.     
  131.     -    the installer no longer allows installation of the Technicolor
  132.         code into BBEdit, since BBEdit now supports syntax-directed
  133.         coloring of text.
  134.         
  135. Version 2.8:
  136.  
  137.     -    incorporates fix to some reported problems in the C scanner.
  138.     
  139.     -    the C++ scanner now properly handles template-based typedefs.
  140.     
  141.     -    installs version 0.9.6 of Technicolor, which fixes some bugs
  142.         in that system.
  143.         
  144.     -    the suffix mapping now processes file names of the form "foo.c,xx"
  145.         (where "xx" is some number), so that PopupFuncs is enabled for files
  146.         created by MPW's "CompareRevisions" script.
  147.     
  148.     -    adds Java support
  149.     
  150.     -    incorporates improvements to assembly-language scanning to
  151.         facilitate use with PowerPC assembly language.
  152.         
  153. Version 2.7:
  154.  
  155.     -    incorporates rewritten Pascal scanner, with much better support
  156.         for Object Pascal, and generally more reliable operation.
  157.         
  158.     -    C++ scanner adds support for overloaded operators.
  159.  
  160. Version 2.6.1:
  161.  
  162.     -    Incorporates support for CodeWarrior 1.3 (CW7 distribution)
  163.     
  164. Version 2.6:
  165.  
  166.     -    incorporates support for MPW Shell 3.4b6 and later
  167.     
  168. */
  169.  
  170. #pragma mark A Note About Technicolor
  171.  
  172. /*
  173. A Note About Technicolor
  174. - ---- ----- -----------
  175.  
  176. As a convenience, PopupFuncs provides a facility for installing
  177. Chris Thomas' "Technicolor" utility. Technicolor is a tool for providing
  178. syntax-directed text coloring in environments that don't otherwise offer
  179. such a capability. In addition to installation from the PopupFuncs
  180. installer, the standard PopupFuncs distribution includes the latest
  181. version (0.9.5, as of this writing) of Technicolor.
  182.  
  183. Technicolor is not a product of Bare Bones Software, and we cannot
  184. support it. Please direct questions regarding Technicolor to Chris
  185. Thomas <ckt@best.com>.
  186.  
  187. */
  188.  
  189. #pragma mark Using PopupFuncs
  190.  
  191. /*
  192. Using PopupFuncs
  193. ----- ----------
  194.  
  195. PopupFuncs will place a pair of red dots in the title bar of any window that
  196. it believes contains a source file. To pop up a menu of functions in your
  197. source file, click either of the red dots. To sort the menu items by name,
  198. hold down the Shift key when clicking. To show the available PopupFuncs
  199. extensions, hold down the Command key when clicking.
  200.  
  201. In Rez source files, PopupFuncs will list defined resources. In C and C++
  202. source files, PopupFuncs will show types in addition to functions.
  203. */
  204.  
  205. #pragma mark Customizing PopupFuncs
  206.  
  207. /*
  208. Customizing PopupFuncs
  209. ----------- ----------
  210.  
  211. PopupFuncs includes a number of special-purpose resources, which can be
  212. edited to customize the behavior of PopupFuncs. These resources, along 
  213. with a ‘TMPL’ resource, are included in the PopupFuncs installer. If
  214. you change these resources in the PopupFuncs installer, the changes
  215. will be carried along with subsequent installations of PopupFuncs.
  216.  
  217. The resources have a type of ‘puf!’, and the standard ones are as follows:
  218.  
  219. ‘puf!’ 128 is a list of language-to-suffix mappings. The language code
  220. is zero-based, and progresses as follows:
  221.  
  222.     none = 0;
  223.     C = 1;
  224.     C++ = 2;
  225.     Pascal = 3;
  226.     Object Pascal = 4;
  227.     Rez = 5;
  228.     68K assembler = 6;
  229.     Fortran = 7;
  230.     
  231. You can edit the suffix mappings to add your own custom suffixes.
  232.  
  233. ‘puf!’ 129 is used to configure the 68K assembly-language parser. Each
  234. entry in this resource is a pair of label/operand pairs:
  235.  
  236.     0   - mark the label , major. (e.g. PROC,FUNC)
  237.     1   - mark the label, minor 
  238.     2   - mark the parameter, major. Useful for macros whose first parameter 
  239.             is the real function name.
  240.     3    - mark the label, local, with a † next to it (e.g. RECORD)
  241. */
  242.  
  243. #pragma mark Problems?
  244.  
  245. /*
  246. Problems?
  247. ---------
  248.  
  249. If you find that PopUpFuncs has difficulty with a particular source file,
  250. please send us a copy of your file. If the source file contains sensitive
  251. content, use the “Source Masher” utility to generate a copy of the source
  252. file without the sensitive information.
  253. */
  254.  
  255. #pragma mark Thanks!
  256.  
  257. /*
  258. Thanks!
  259. -------
  260.  
  261. Thank you for using PopupFuncs; we appreciate your support. If you
  262. have questions or problems, we encourage you to write, call, or send
  263. e-mail. (E-mail is the recommended way to contact us; we can reply very
  264. quickly, and it conserves paper.)
  265.  
  266. Bare Bones Software, Inc.
  267. P.O. Box 1048
  268. Bedford, MA 01730-1048
  269. (617) 778-3100 phone
  270. (617) 778-3111 fax
  271. support@barebones.com [internet]
  272. http://www.barebones.com/ [World Wide Web]
  273. */
  274.  
  275. #pragma mark Legalese
  276.  
  277. /*
  278. License Agreement                                                        
  279. ------- ---------
  280.  
  281. You, the Licensee, assume responsibility for the selection of the
  282. program PopupFuncs to achieve your intended results, and for the
  283. installation, use, and results obtained from the program.  installing
  284. and using the program constitutes your acceptance of these terms and
  285. conditions.  If you do not accept these terms and conditions, then do
  286. not install or use the software.
  287.  
  288. License
  289. -------
  290.  
  291. You may use the program on a single machine and copy the program into
  292. any machine-readable or printed form for backup or support of your use
  293. of the program on the single machine, provided that no more than one
  294. copy of the program may be used on a single machine by more than one
  295. user at a time. You may distribute copies of the program to other
  296. individuals for non-commercial purposes, but may not sell, license, or
  297. include the program as part of a commercial distribution or compilation
  298. without express written permission of Bare Bones Software, Inc.
  299.  
  300. Limited warranty and limitation of remedies
  301. ------- -------- --- ---------- -- --------
  302.  
  303. The program and any support from Bare Bones Software, Inc., are provided
  304. “as is” and without warranty , express and implied, including but not
  305. limited to any implied warranties of merchantability and fitness for a
  306. particular purpose.  In no event will Bare Bones Software, Inc. be
  307. liable for any damages, including lost profits, lost savings, or other
  308. incidental or consequential damages, even if Bare Bones Software, Inc.
  309. is advised of the possibility of such damages, or for any claim by you
  310. or any third party.  
  311.  
  312. General Terms
  313. ------- -----
  314.  
  315. This Agreement can only be modified by a written agreement signed by you
  316. and Bare Bones Software, Inc., and changes from the terms and conditions
  317. of this Agreement made in any other manner will be of no effect.  If any
  318. portion of this Agreement shall be held invalid, illegal, or
  319. unenforceable, the validity, legality, and enforceability of the
  320. remainder of the Agreement shall not in any way be affected or impaired
  321. thereby.  This Agreement shall be governed by the laws of The
  322. Commonwealth of Massachusetts, without giving effect to conflict of laws
  323. provisions thereof.  As required by United States export regulations,
  324. you shall not permit export of the program or any direct products
  325. thereof to any country to which export is then controlled by the United
  326. States Office of Export Administration, unless you have that agency’s
  327. prior written approval.  
  328.  
  329. Use, duplication and disclosure by the United States Government of the
  330. program or any part thereof is subject to restrictions as set forth in
  331. subdivision (g)(3) of Rights in Data - General Clause in Federal
  332. Acquisition Regulations (“FAR”) 52.227.14, the Commercial Computer
  333. Software - Restricted Rights Clause in FAR 52.227.19. and/or subdivision
  334. c(1)(ii) of Rights in Technical Data and Computer Software Clause in
  335. Department of Defense FAR 252.227.7013.
  336.  
  337. Acknowledgment
  338. --------------
  339.  
  340. You acknowledge that you have read this agreement, understand it, and
  341. agree to be bound by its terms and conditions.  You further agree that
  342. it is the complete and exclusive statement of the agreement between you
  343. and Bare Bones Software, Inc. which supersedes all proposals or prior
  344. agreements, oral or written, and all other communications between you
  345. and Bare Bones Software, Inc. relating to the subject matter of this
  346. agreement.
  347. */
  348.